Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional macOS codesign entitlements and print verbose #98126

Conversation

TCROC
Copy link
Contributor

@TCROC TCROC commented Oct 12, 2024

This PR adds 2 additional things for macos exports:

  1. You can add additional entitlements that the godot editor doesn't cover via the new codesign/entitlements/additional property. This behaves similarly to the application/additional_plist_content property for adding additional plist elements the godot editor gui doesn't cover.
    • Reasoning: We need to add "login with apple" capability to my macos application. This entitlement is not covered in the list of entitlement check boxes. This makes it easy to add additional entitlements that the godot editor doesn't cover via its checkbox gui.
  2. When exporting in verbose mode, the value of the entitlement files is printed. This is useful because godot treats these as temporary files and deletes them after exporting. By printing them during the export process, users can more effectively debug potential entitlement issues with their application. It also has the added benefit of acting as a template for a custom entitlement file if users wish to go the route of manually managing an entitlement file.

As always, Lange Studios thanks you for the awesome engine! Please let me know if you have any feedback on the PR or wish us to change anything :)

@TCROC TCROC requested a review from a team as a code owner October 12, 2024 22:43
@TCROC
Copy link
Contributor Author

TCROC commented Oct 12, 2024

Why is the pipeline unhappy? I read the error but I don't understand what it means.

@cadence-s
Copy link
Contributor

Why is the pipeline unhappy? I read the error but I don't understand what it means.

Looks like it wants you to add documentation for the new property.

@TCROC
Copy link
Contributor Author

TCROC commented Oct 12, 2024

Why is the pipeline unhappy? I read the error but I don't understand what it means.

Looks like it wants you to add documentation for the new property.

Thanks @cadence-s :) I've never added documentation before. So 2 questions:

  1. Does godot have documentation somewhere for contributors on how to add documentation? Rules to follow and such?
  2. How did you gather that from this pipeline error message?
    image

Thanks! :)

@TCROC TCROC force-pushed the macos-codesign-additional-entitlements branch from 114acdd to d869a00 Compare October 13, 2024 00:00
@TCROC TCROC requested a review from a team as a code owner October 13, 2024 00:00
@TCROC
Copy link
Contributor Author

TCROC commented Oct 13, 2024

figured it out. thanks @cadence-s :)

@TCROC
Copy link
Contributor Author

TCROC commented Oct 13, 2024

@cadence-s i lied. I thought I figured it out. It's still unhappy and I don't know why :(

@cadence-s
Copy link
Contributor

It thinks your formatting is wrong because there's a stray "+" character

@TCROC
Copy link
Contributor Author

TCROC commented Oct 13, 2024

Thanks @cadence-s ! :) I'll fix that :)

@bruvzg
Copy link
Member

bruvzg commented Oct 13, 2024

Does godot have documentation somewhere for contributors on how to add documentation? Rules to follow and such?

See https://docs.godotengine.org/en/stable/contributing/documentation/updating_the_class_reference.html#doc-updating-the-class-reference

Run editor (compiled from your branch) from the repo root, with the --doctool argument, and it will regenerate docs.

You can also enable pre-commit hooks to run static checks (and automatically apply style fixes) locally.

@TCROC
Copy link
Contributor Author

TCROC commented Oct 13, 2024

figured it out. thanks @cadence-s :)

Does godot have documentation somewhere for contributors on how to add documentation? Rules to follow and such?

See https://docs.godotengine.org/en/stable/contributing/documentation/updating_the_class_reference.html#doc-updating-the-class-reference

Run editor (compiled from your branch) from the repo root, with the --doctool argument, and it will regenerate docs.

You can also enable pre-commit hooks to run static checks (and automatically apply style fixes) locally.

Brilliant! Thank you! :)

@TCROC TCROC force-pushed the macos-codesign-additional-entitlements branch from d869a00 to 5777a3f Compare October 13, 2024 13:33
@AThousandShips AThousandShips changed the title Additional macos codesign entitlements and print verbose Additional macOS codesign entitlements and print verbose Oct 14, 2024
@Repiteo Repiteo modified the milestones: 4.x, 4.4 Oct 16, 2024
@Repiteo Repiteo merged commit 6ccff9b into godotengine:master Oct 16, 2024
20 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Oct 16, 2024

Thanks!

@TCROC
Copy link
Contributor Author

TCROC commented Oct 16, 2024

Thanks!

Absolutely! And thank you as well! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants